<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  "DTD/xhtml1-strict.dtd">
<html>
  <head>
    <title>API docs for &ldquo;pymine.beautifulsoup.BeautifulSoup.PageElement&rdquo;</title>
    <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
    <link href="apidocs.css" type="text/css" rel="stylesheet" />
    
    
  </head>
  <body>
    <h1 class="class">Class p.b.B.PageElement(<span title="object">object</span>):</h1>
    <p>
      <span id="part">Part of <a href="pymine.html">pymine</a>.<a href="pymine.beautifulsoup.html">beautifulsoup</a>.<a href="pymine.beautifulsoup.BeautifulSoup.html">BeautifulSoup</a></span>
      
      <a href="classIndex.html#pymine.beautifulsoup.BeautifulSoup.PageElement">View In Hierarchy</a>
    </p>
    <div>
      <p>Known subclasses: <a href="pymine.beautifulsoup.BeautifulSoup.NavigableString.html">pymine.beautifulsoup.BeautifulSoup.NavigableString</a>, <a href="pymine.beautifulsoup.BeautifulSoup.Tag.html">pymine.beautifulsoup.BeautifulSoup.Tag</a></p>
    </div>
    <div>Contains the navigational information for some part of the page (either 
a tag or a piece of text)<table class="fieldTable"></table></div>
    
    
    <div id="splitTables">
      <table class="children sortable" id="id45">
  
  
  
  
  <tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#setup">setup</a></td>
    <td><span>Sets up the initial relations between this element and</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#replaceWith">replaceWith</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#replaceWithChildren">replaceWithChildren</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#extract">extract</a></td>
    <td><span>Destructively rips this element out of the tree.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#_lastRecursiveChild">_lastRecursiveChild</a></td>
    <td><span>Finds the last element beneath this object to be parsed.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#insert">insert</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#append">append</a></td>
    <td><span>Appends the given tag to the contents of this tag.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#findNext">findNext</a></td>
    <td><span>Returns the first item that matches the given criteria and</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#findAllNext">findAllNext</a></td>
    <td><span>Returns all items that match the given criteria and appear</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#findNextSibling">findNextSibling</a></td>
    <td><span>Returns the closest sibling to this Tag that matches the</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#findNextSiblings">findNextSiblings</a></td>
    <td><span>Returns the siblings of this Tag that match the given</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#findPrevious">findPrevious</a></td>
    <td><span>Returns the first item that matches the given criteria and</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#findAllPrevious">findAllPrevious</a></td>
    <td><span>Returns all items that match the given criteria and appear</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#findPreviousSibling">findPreviousSibling</a></td>
    <td><span>Returns the closest sibling to this Tag that matches the</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#findPreviousSiblings">findPreviousSiblings</a></td>
    <td><span>Returns the siblings of this Tag that match the given</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#findParent">findParent</a></td>
    <td><span>Returns the closest parent of this Tag that matches the given</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#findParents">findParents</a></td>
    <td><span>Returns the parents of this Tag that match the given</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#_findOne">_findOne</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#_findAll">_findAll</a></td>
    <td><span>Iterates over a generator looking for things that match.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#nextGenerator">nextGenerator</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#nextSiblingGenerator">nextSiblingGenerator</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#previousGenerator">previousGenerator</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#previousSiblingGenerator">previousSiblingGenerator</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#parentGenerator">parentGenerator</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#substituteEncoding">substituteEncoding</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#toEncoding">toEncoding</a></td>
    <td><span>Encodes an object to a string in some encoding, or to Unicode.</span></td>
  </tr>
  
</table>
      
      
    </div>
    
    
    
    <div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.setup"></a>
        <a name="setup"></a>
        <div class="functionHeader">
        
        def setup(self, parent=None, previous=None):
        
      </div>
        <div class="functionBody">
          
          <div>Sets up the initial relations between this element and other 
elements.<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.replaceWith"></a>
        <a name="replaceWith"></a>
        <div class="functionHeader">
        
        def replaceWith(self, replaceWith):
        
      </div>
        <div class="functionBody">
          
          <div class="undocumented">Undocumented</div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.replaceWithChildren"></a>
        <a name="replaceWithChildren"></a>
        <div class="functionHeader">
        
        def replaceWithChildren(self):
        
      </div>
        <div class="functionBody">
          
          <div class="undocumented">Undocumented</div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.extract"></a>
        <a name="extract"></a>
        <div class="functionHeader">
        
        def extract(self):
        
      </div>
        <div class="functionBody">
          
          <div>Destructively rips this element out of the tree.<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement._lastRecursiveChild"></a>
        <a name="_lastRecursiveChild"></a>
        <div class="functionHeader">
        
        def _lastRecursiveChild(self):
        
      </div>
        <div class="functionBody">
          
          <div>Finds the last element beneath this object to be parsed.<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.insert"></a>
        <a name="insert"></a>
        <div class="functionHeader">
        
        def insert(self, position, newChild):
        
      </div>
        <div class="functionBody">
          
          <div class="undocumented">Undocumented</div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.append"></a>
        <a name="append"></a>
        <div class="functionHeader">
        
        def append(self, tag):
        
      </div>
        <div class="functionBody">
          
          <div>Appends the given tag to the contents of this tag.<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.findNext"></a>
        <a name="findNext"></a>
        <div class="functionHeader">
        
        def findNext(self, name=None, attrs={}, text=None, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>Returns the first item that matches the given criteria and appears after
this Tag in the document.<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.findAllNext"></a>
        <a name="findAllNext"></a>
        <div class="functionHeader">
        
        def findAllNext(self, name=None, attrs={}, text=None, limit=None, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>Returns all items that match the given criteria and appear after this 
Tag in the document.<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.findNextSibling"></a>
        <a name="findNextSibling"></a>
        <div class="functionHeader">
        
        def findNextSibling(self, name=None, attrs={}, text=None, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>Returns the closest sibling to this Tag that matches the given criteria 
and appears after this Tag in the document.<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.findNextSiblings"></a>
        <a name="findNextSiblings"></a>
        <div class="functionHeader">
        
        def findNextSiblings(self, name=None, attrs={}, text=None, limit=None, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>Returns the siblings of this Tag that match the given criteria and 
appear after this Tag in the document.<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.findPrevious"></a>
        <a name="findPrevious"></a>
        <div class="functionHeader">
        
        def findPrevious(self, name=None, attrs={}, text=None, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>Returns the first item that matches the given criteria and appears 
before this Tag in the document.<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.findAllPrevious"></a>
        <a name="findAllPrevious"></a>
        <div class="functionHeader">
        
        def findAllPrevious(self, name=None, attrs={}, text=None, limit=None, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>Returns all items that match the given criteria and appear before this 
Tag in the document.<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.findPreviousSibling"></a>
        <a name="findPreviousSibling"></a>
        <div class="functionHeader">
        
        def findPreviousSibling(self, name=None, attrs={}, text=None, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>Returns the closest sibling to this Tag that matches the given criteria 
and appears before this Tag in the document.<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.findPreviousSiblings"></a>
        <a name="findPreviousSiblings"></a>
        <div class="functionHeader">
        
        def findPreviousSiblings(self, name=None, attrs={}, text=None, limit=None, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>Returns the siblings of this Tag that match the given criteria and 
appear before this Tag in the document.<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.findParent"></a>
        <a name="findParent"></a>
        <div class="functionHeader">
        
        def findParent(self, name=None, attrs={}, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>Returns the closest parent of this Tag that matches the given 
criteria.<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.findParents"></a>
        <a name="findParents"></a>
        <div class="functionHeader">
        
        def findParents(self, name=None, attrs={}, limit=None, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>Returns the parents of this Tag that match the given criteria.<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement._findOne"></a>
        <a name="_findOne"></a>
        <div class="functionHeader">
        
        def _findOne(self, method, name, attrs, text, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div class="undocumented">Undocumented</div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement._findAll"></a>
        <a name="_findAll"></a>
        <div class="functionHeader">
        
        def _findAll(self, name, attrs, text, limit, generator, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>Iterates over a generator looking for things that match.<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.nextGenerator"></a>
        <a name="nextGenerator"></a>
        <div class="functionHeader">
        
        def nextGenerator(self):
        
      </div>
        <div class="functionBody">
          
          <div class="undocumented">Undocumented</div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.nextSiblingGenerator"></a>
        <a name="nextSiblingGenerator"></a>
        <div class="functionHeader">
        
        def nextSiblingGenerator(self):
        
      </div>
        <div class="functionBody">
          
          <div class="undocumented">Undocumented</div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.previousGenerator"></a>
        <a name="previousGenerator"></a>
        <div class="functionHeader">
        
        def previousGenerator(self):
        
      </div>
        <div class="functionBody">
          
          <div class="undocumented">Undocumented</div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.previousSiblingGenerator"></a>
        <a name="previousSiblingGenerator"></a>
        <div class="functionHeader">
        
        def previousSiblingGenerator(self):
        
      </div>
        <div class="functionBody">
          
          <div class="undocumented">Undocumented</div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.parentGenerator"></a>
        <a name="parentGenerator"></a>
        <div class="functionHeader">
        
        def parentGenerator(self):
        
      </div>
        <div class="functionBody">
          
          <div class="undocumented">Undocumented</div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.substituteEncoding"></a>
        <a name="substituteEncoding"></a>
        <div class="functionHeader">
        
        def substituteEncoding(self, str, encoding=None):
        
      </div>
        <div class="functionBody">
          
          <div class="undocumented">Undocumented</div>
        </div>
      </div><div class="function">
        <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.toEncoding"></a>
        <a name="toEncoding"></a>
        <div class="functionHeader">
        
        def toEncoding(self, s, encoding=None):
        
      </div>
        <div class="functionBody">
          
          <div>Encodes an object to a string in some encoding, or to Unicode. .<table class="fieldTable"></table></div>
        </div>
      </div>
    
    <address>
      <a href="index.html">API Documentation</a> for pymine, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2010-04-07 23:15:24.
    </address>
  </body>
</html>